Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard
<?php // You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip require('RestClient.php'); $api_url = 'https://api.dataforseo.com/'; try { // Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard $client = new RestClient($api_url, null, 'login', 'password'); } catch (RestClientException $e) { echo "\n"; print "HTTP code: {$e->getHttpCode()}\n"; print "Error code: {$e->getCode()}\n"; print "Message: {$e->getMessage()}\n"; print $e->getTraceAsString(); echo "\n"; exit(); } try { $result = array(); // #1 - using this method you can get a list of completed tasks // GET /v3/serp/{{low_se_name}}/{{low_se_type}}/tasks_ready // in addition to '{{low_se_name}}' and '{{low_se_type}}' you can also set other search engine and type parameters // the full list of possible parameters is available in documentation $tasks_ready = $client->get('/v3/serp/{{low_se_name}}/{{low_se_type}}/tasks_ready'); // you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors if (isset($tasks_ready['status_code']) AND $tasks_ready['status_code'] === 20000) { foreach ($tasks_ready['tasks'] as $task) { if (isset($task['result'])) { foreach ($task['result'] as $task_ready) { // #2 - using this method you can get results of each completed task // GET /v3/serp/{{low_se_name}}/{{low_se_type}}/task_get/regular/$id if (isset($task_ready['endpoint_regular'])) { $result[] = $client->get($task_ready['endpoint_regular']); } // #3 - another way to get the task results by id // GET /v3/serp/{{low_se_name}}/{{low_se_type}}/task_get/regular/$id /* if (isset($task_ready['id'])) { $result[] = $client->get('/v3/serp/{{low_se_name}}/{{low_se_type}}/task_get/regular/' . $task_ready['id']); } */ } } } } print_r($result); // do something with result } catch (RestClientException $e) { echo "\n"; print "HTTP code: {$e->getHttpCode()}\n"; print "Error code: {$e->getCode()}\n"; print "Message: {$e->getMessage()}\n"; print $e->getTraceAsString(); echo "\n"; } $client = null; ?>
The above command returns JSON structured like this:
{ "version": "0.1.20200129", "status_code": 20000, "status_message": "Ok.", "time": "0.0349 sec.", "cost": 0, "tasks_count": 1, "tasks_error": 0, "tasks": [ { "id": "11151456-0696-0066-0000-002a5915da37", "status_code": 20000, "status_message": "Ok.", "time": "0.0168 sec.", "cost": 0, "result_count": 1, "path": [ "v3", "serp", "{{low_se_name}}", "{{low_se_type_under}}", "task_get", "regular", "11151456-0696-0066-0000-002a5915da37" ], "data": { "api": "serp", "function": "task_get", "se": "{{low_se_name}}", "se_type": "{{low_se_type_under}}", "language_code": "en", "location_code": 9073502, "keyword": "coffee shops near me", "device": "desktop", "os": "windows" }, "result": [ { "keyword": "coffee shops near me", "type": "{{low_se_type_under}}", "se_domain": "{{low_se_name}}.com", "location_code": 9073502, "language_code": "en", "check_url": "https://www.bing.com/entities/search?q=coffee%20shops%20near%20me&filters=segment%3A%22local%22&setlang=en&cc=US&safesearch=Moderate", "datetime": "2019-11-15 12:57:46 +00:00", "spell": null, "refinement_chips": null, "item_types": [ "local_pack" ], "se_results_count": 85600000, "items_count": 24, "items": [ { "type": "local_pack", "rank_group": 1, "rank_absolute": 5, "position": "left", "domain": "www.ciolaingocoffeeco.com", "title": "Ciolaingo Coffee Company", "description": "Yelp (2)\r\nCoffee House\r\nOpen · Closes 5 PM\r\n127 W 141st St #36, New York", "url": "https://www.ciolaingocoffeeco.com/" } ] } ] } ] }
Description of the fields for sending a request:
Field name | Type | Description |
---|---|---|
id |
string | task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time |
As a response of the API server, you will receive JSON-encoded data containing a tasks
array with the information specific to the set tasks.
You can also get all available SERP features by making a request to the following Sandbox URL:
https://sandbox.dataforseo.com/v3/serp/bing/local_pack/task_get/regular/00000000-0000-0000-0000-000000000000
The response will include all available items in the Bing Local Pack SERP Regular endpoint with the fields containing dummy data.
You won’t be charged for using Sandbox endpoints.
Description of the fields in the results array:
Field name | Type | Description |
---|---|---|
version |
string | the current version of the API |
status_code |
integer | general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions |
status_message |
string | general informational message you can find the full list of general informational messages here |
time |
string | execution time, seconds |
cost |
float | total tasks cost, USD |
tasks_count |
integer | the number of tasks in the tasks array |
tasks_error |
integer | the number of tasks in the tasks array returned with an error |
tasks |
array | array of tasks |
id |
string | task identifier unique task identifier in our system in the UUID format |
status_code |
integer | status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here |
status_message |
string | informational message of the task you can find the full list of general informational messages here |
time |
string | execution time, seconds |
cost |
float | cost of the task, USD |
result_count |
integer | number of elements in the result array |
path |
array | URL path |
data |
object | contains the same parameters that you specified in the POST request |
result |
array | array of results |
keyword |
string | keyword received in a POST array the keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character) |
type |
string | search engine type in a POST array |
se_domain |
string | search engine domain in a POST array |
location_code |
integer | location code in a POST array |
language_code |
string | language code in a POST array |
check_url |
string | direct URL to search engine results you can use it to make sure that we provided accurate results |
datetime |
string | date and time when the result was received in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 |
spell |
object | autocorrection of the search engine if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection equals null |
refinement_chips |
object | search refinement chips equals null |
item_types |
array | types of search results in SERP contains types of search results ( items ) found in SERP.possible item types: local_pack |
se_results_count |
integer | total number of results in SERP |
items_count |
integer | the number of results returned in the items array |
items |
array | elements of search results found in SERP |
‘local_pack’ element in SERP | ||
type |
string | type of element = ‘local_pack’ |
rank_group |
integer | group rank in SERP position within a group of elements with identical type valuespositions of elements with different type values are omitted from rank_group |
rank_absolute |
integer | absolute rank in SERP for the target domain absolute position among all the elements in SERP |
position |
string | the arrangement of the element in SERP here you can find the following elements: left , right |
domain |
string | domain in SERP |
title |
string | title of the result in SERP |
description |
string | description of the results element in SERP |
url |
string | relevant URL |